home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / zhpgvd.z / zhpgvd
Encoding:
Text File  |  2002-10-03  |  8.6 KB  |  265 lines
  1.  
  2.  
  3.  
  4. ZZZZHHHHPPPPGGGGVVVVDDDD((((3333SSSS))))                                                          ZZZZHHHHPPPPGGGGVVVVDDDD((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ZHPGVD - compute all the eigenvalues and, optionally, the eigenvectors of
  10.      a complex generalized Hermitian-definite eigenproblem, of the form
  11.      A*x=(lambda)*B*x, A*Bx=(lambda)*x, or B*A*x=(lambda)*x
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE ZHPGVD( ITYPE, JOBZ, UPLO, N, AP, BP, W, Z, LDZ, WORK, LWORK,
  15.                         RWORK, LRWORK, IWORK, LIWORK, INFO )
  16.  
  17.          CHARACTER      JOBZ, UPLO
  18.  
  19.          INTEGER        INFO, ITYPE, LDZ, LIWORK, LRWORK, LWORK, N
  20.  
  21.          INTEGER        IWORK( * )
  22.  
  23.          DOUBLE         PRECISION RWORK( * ), W( * )
  24.  
  25.          COMPLEX*16     AP( * ), BP( * ), WORK( * ), Z( LDZ, * )
  26.  
  27. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  28.      These routines are part of the SCSL Scientific Library and can be loaded
  29.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  30.      directs the linker to use the multi-processor version of the library.
  31.  
  32.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  33.      4 bytes (32 bits). Another version of SCSL is available in which integers
  34.      are 8 bytes (64 bits).  This version allows the user access to larger
  35.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  36.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  37.      only one of the two versions; 4-byte integer and 8-byte integer library
  38.      calls cannot be mixed.
  39.  
  40. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  41.      ZHPGVD computes all the eigenvalues and, optionally, the eigenvectors of
  42.      a complex generalized Hermitian-definite eigenproblem, of the form
  43.      A*x=(lambda)*B*x, A*Bx=(lambda)*x, or B*A*x=(lambda)*x. Here A and B are
  44.      assumed to be Hermitian, stored in packed format, and B is also positive
  45.      definite.
  46.      If eigenvectors are desired, it uses a divide and conquer algorithm.
  47.  
  48.      The divide and conquer algorithm makes very mild assumptions about
  49.      floating point arithmetic. It will work on machines with a guard digit in
  50.      add/subtract, or on those binary machines without guard digits which
  51.      subtract like the Cray X-MP, Cray Y-MP, Cray C-90, or Cray-2. It could
  52.      conceivably fail on hexadecimal or decimal machines without guard digits,
  53.      but we know of none.
  54.  
  55.  
  56. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  57.      ITYPE   (input) INTEGER
  58.              Specifies the problem type to be solved:
  59.              = 1:  A*x = (lambda)*B*x
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ZZZZHHHHPPPPGGGGVVVVDDDD((((3333SSSS))))                                                          ZZZZHHHHPPPPGGGGVVVVDDDD((((3333SSSS))))
  71.  
  72.  
  73.  
  74.              = 2:  A*B*x = (lambda)*x
  75.              = 3:  B*A*x = (lambda)*x
  76.  
  77.      JOBZ    (input) CHARACTER*1
  78.              = 'N':  Compute eigenvalues only;
  79.              = 'V':  Compute eigenvalues and eigenvectors.
  80.  
  81.      UPLO    (input) CHARACTER*1
  82.              = 'U':  Upper triangles of A and B are stored;
  83.              = 'L':  Lower triangles of A and B are stored.
  84.  
  85.      N       (input) INTEGER
  86.              The order of the matrices A and B.  N >= 0.
  87.  
  88.      AP      (input/output) COMPLEX*16 array, dimension (N*(N+1)/2)
  89.              On entry, the upper or lower triangle of the Hermitian matrix A,
  90.              packed columnwise in a linear array.  The j-th column of A is
  91.              stored in the array AP as follows:  if UPLO = 'U', AP(i + (j-
  92.              1)*j/2) = A(i,j) for 1<=i<=j; if UPLO = 'L', AP(i + (j-1)*(2*n-
  93.              j)/2) = A(i,j) for j<=i<=n.
  94.  
  95.              On exit, the contents of AP are destroyed.
  96.  
  97.      BP      (input/output) COMPLEX*16 array, dimension (N*(N+1)/2)
  98.              On entry, the upper or lower triangle of the Hermitian matrix B,
  99.              packed columnwise in a linear array.  The j-th column of B is
  100.              stored in the array BP as follows:  if UPLO = 'U', BP(i + (j-
  101.              1)*j/2) = B(i,j) for 1<=i<=j; if UPLO = 'L', BP(i + (j-1)*(2*n-
  102.              j)/2) = B(i,j) for j<=i<=n.
  103.  
  104.              On exit, the triangular factor U or L from the Cholesky
  105.              factorization B = U**H*U or B = L*L**H, in the same storage
  106.              format as B.
  107.  
  108.      W       (output) DOUBLE PRECISION array, dimension (N)
  109.              If INFO = 0, the eigenvalues in ascending order.
  110.  
  111.      Z       (output) COMPLEX*16 array, dimension (LDZ, N)
  112.              If JOBZ = 'V', then if INFO = 0, Z contains the matrix Z of
  113.              eigenvectors.  The eigenvectors are normalized as follows:  if
  114.              ITYPE = 1 or 2, Z**H*B*Z = I; if ITYPE = 3, Z**H*inv(B)*Z = I.
  115.              If JOBZ = 'N', then Z is not referenced.
  116.  
  117.      LDZ     (input) INTEGER
  118.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  119.              'V', LDZ >= max(1,N).
  120.  
  121.      WORK    (workspace) COMPLEX*16 array, dimension (LWORK)
  122.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ZZZZHHHHPPPPGGGGVVVVDDDD((((3333SSSS))))                                                          ZZZZHHHHPPPPGGGGVVVVDDDD((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      LWORK   (input) INTEGER
  141.              The dimension of array WORK.  If N <= 1,               LWORK >=
  142.              1.  If JOBZ = 'N' and N > 1, LWORK >= N.  If JOBZ = 'V' and N >
  143.              1, LWORK >= 2*N.
  144.  
  145.              If LWORK = -1, then a workspace query is assumed; the routine
  146.              only calculates the optimal size of the WORK array, returns this
  147.              value as the first entry of the WORK array, and no error message
  148.              related to LWORK is issued by XERBLA.
  149.  
  150.      RWORK   (workspace) DOUBLE PRECISION array, dimension (LRWORK)
  151.              On exit, if INFO = 0, RWORK(1) returns the optimal LRWORK.
  152.  
  153.      LRWORK  (input) INTEGER
  154.              The dimension of array RWORK.  If N <= 1,               LRWORK >=
  155.              1.  If JOBZ = 'N' and N > 1, LRWORK >= N.  If JOBZ = 'V' and N >
  156.              1, LRWORK >= 1 + 5*N + 2*N**2.
  157.  
  158.              If LRWORK = -1, then a workspace query is assumed; the routine
  159.              only calculates the optimal size of the RWORK array, returns this
  160.              value as the first entry of the RWORK array, and no error message
  161.              related to LRWORK is issued by XERBLA.
  162.  
  163.      IWORK   (workspace/output) INTEGER array, dimension (LIWORK)
  164.              On exit, if INFO = 0, IWORK(1) returns the optimal LIWORK.
  165.  
  166.      LIWORK  (input) INTEGER
  167.              The dimension of array IWORK.  If JOBZ  = 'N' or N <= 1, LIWORK
  168.              >= 1.  If JOBZ  = 'V' and N > 1, LIWORK >= 3 + 5*N.
  169.  
  170.              If LIWORK = -1, then a workspace query is assumed; the routine
  171.              only calculates the optimal size of the IWORK array, returns this
  172.              value as the first entry of the IWORK array, and no error message
  173.              related to LIWORK is issued by XERBLA.
  174.  
  175.      INFO    (output) INTEGER
  176.              = 0:  successful exit
  177.              < 0:  if INFO = -i, the i-th argument had an illegal value
  178.              > 0:  ZPPTRF or ZHPEVD returned an error code:
  179.              <= N:  if INFO = i, ZHPEVD failed to converge; i off-diagonal
  180.              elements of an intermediate tridiagonal form did not convergeto
  181.              zero; > N:   if INFO = N + i, for 1 <= i <= n, then the leading
  182.              minor of order i of B is not positive definite.  The
  183.              factorization of B could not be completed and no eigenvalues or
  184.              eigenvectors were computed.
  185.  
  186. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  187.      Based on contributions by
  188.         Mark Fahey, Department of Mathematics, Univ. of Kentucky, USA
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. ZZZZHHHHPPPPGGGGVVVVDDDD((((3333SSSS))))                                                          ZZZZHHHHPPPPGGGGVVVVDDDD((((3333SSSS))))
  203.  
  204.  
  205.  
  206. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  207.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  208.  
  209.      This man page is available only online.
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.